/*
 * Flashlib - QB9 common Flash library
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.qb9.flashlib.fsm
{
	import com.qb9.flashlib.tasks.*;
	import flash.events.*;
	
	/**
	 * Interface for classes which can generate new Transition instances.
	 */
	public interface ITransitionBuilder
	{
		/**
		 * Specify a transition for a given event.
		 *
		 * @param type Event type to listen for.
		 * @param dispatcher Event dispatcher that will be used to register the event listener. If not specified, the IState instance will be used.
		 *
		 * @return a Transition instance that can be used to specify the action to be taken when the event is dispatched.
		 */
		function onEvent(type:String, dispatcher:IEventDispatcher = null):Transition;
		
		/**
		 * Specify a transition to be fired after a certain amount of time in the given state.
		 *
		 * @param milliseconds Amount of time.
		 *
		 * @return a Transition instance that can be used to specify the action to be taken when the event is dispatched.
		 */
		function after(milliseconds:uint):Transition;
	}
}
